home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / galwar75.zip / DDTERM21.ZIP / DDTERM.DOC < prev    next >
Text File  |  1990-07-16  |  9KB  |  224 lines
  1. DDTerm ver 2.00
  2.  
  3. By Scott Baker
  4.  
  5.        DDTerm is a terminal program that has been written especially for use
  6. with bbs door games utilizing the DoorDriver door support library. (Currently,
  7. this include GALACTIC WARZONE ver 7.5). While DDTerm may be used as a normal
  8. terminal program at any time, it does have several special features which will
  9. kick in when it is running with a door compiled using DoorDriver version
  10. 3.10 or above. (Galactic Warzone version 7.5 is currently the only door
  11. available meeting that criteria).
  12.        When communicating with a DoorDriver 3.10+ door, DDTerm will have the
  13. following extra features:
  14.  
  15.        1) "Short" color codes. The door will send 3-byte color sequences
  16.           rather than the ANSI format 5+ byte sequences. This makes running
  17.           doors with color enabled almost as fast as running them without
  18.           color.
  19.  
  20.        2) Remote packet display capabilities. This is really the most
  21.           important feature of DDTerm. The door will transfer certain
  22.           "packets" to the user. Once transferred, the door will then
  23.           send messages to DDTerm so DDTerm may display these packets
  24.           locally rather than having them be sent remote each time they
  25.           are needed. (i.e. The galactic warzone main menu will only be
  26.           sent once across the modem. After that, all displays of the menu
  27.           are done locally)
  28.  
  29.        3) Pop up windows. The host program can send a code to pop up a window
  30.           within DDTerm. This provides for a nicer display that your
  31.           average scrolling text displays.
  32.  
  33.        4) Time limit updating. The host will automatically transmit the users
  34.           time limit information to DDTerm. DDTerm then can use this
  35.           information to keep an updated copy of how much time you have
  36.           before log off.
  37.  
  38.        5) Context sensitive help.
  39.  
  40.        DDTerm also has a few special features which are available while
  41. running under any door.
  42.  
  43.        1) 200 line COLOR scrollback display. (The colors are preserved
  44.           in the scrollback - looks very nice)
  45.  
  46.        2) FOSSIL driver support.
  47.  
  48.        3) Built in async comm routines.
  49.  
  50.  
  51. HOW TO INSTALL DDTERM
  52. ---------------------
  53.  
  54.        1) Create a directory for DDTERM. (DDTerm creates a lot of temporary
  55.           files; You probably don't want them in your terminal programs
  56.           directory)
  57.  
  58.        2) Place the files you received in the DDTERM.ZIP file into that
  59.           directory (i.e. DDTERM.EXE, DDTERM.DOC, etc)
  60.  
  61.        3) DDTERM may now be invoked by typing "DDTERM" at the dos command
  62.           line (with any optional parameters)
  63.  
  64. USING DDTERM
  65. ------------
  66.        The best way to go about using DDTerm is to use your normal terminal
  67. program to call up the BBS you wish to use, enter the doors area, and then
  68. SHELL/EXIT to DDTERM from within your terminal program. (You may use a
  69. DROP-TO-DOS feature of some terminal programs or you may set up DDTERM as an
  70. external protocol from your terminal program)
  71.  
  72. DDTERM PARAMETERS
  73. -----------------
  74.        DDTerm may be invoked with the following parameters:
  75.  
  76.        DDTERM [COM n] [BAUD n] [FOSSIL]
  77.  
  78.        The parameter COM will tell DDTerm which port to use (COM1 is
  79.        assumed.) You may also change the current port from within
  80.        DDTerm.
  81.  
  82.        The parameter BAUD will tell DDTerm what baud rate to use.
  83.  
  84.        If you specify FOSSIL, DDTerm will attempt to use a FOSSIL driver.
  85.        Fossil drivers are commonly used by bbs systems as a standard way
  86.        to do serial communication. If you wish to use this option, then you
  87.        must already have a FOSSIL such as OpusComm, X00, or BNU loaded.
  88.  
  89.        EXAMPLES:
  90.  
  91.           DDTERM COM 2 BAUD 2400
  92.  
  93.           Invoke DDTerm using COM2 and 2400 baud.
  94.  
  95.  
  96.           DDTERM COM 3 BAUD 300 FOSSIL
  97.  
  98.           Invoke DDTerm using COM3, 300 baud, and a fossil.
  99.  
  100.  
  101.           DDTERM BAUD 9600
  102.  
  103.           Invoke DDTerm using COM1 at 9600 baud.
  104.  
  105. THE BASIC GOAL OF DDTERM
  106. ------------------------
  107.        The basic goal of DDTerm is to provide a friendlier user interface -
  108. since most doors are character-oriented programs, DDTerm tries to speed
  109. things up and add a few windowing routines to make the door appear more
  110. like a traditional applications program.
  111.  
  112. TECHNICAL INFORMATION
  113. ---------------------
  114.        DDTerm will maintain a series of "packet files" on the user side of the
  115. conection. These packet files contain the data for the packets that the
  116. host sends across the modem. Packets are written to disk so that the host
  117. need not retransmit them at the next logon.
  118.        A typical DDTerm session will look like the following:
  119.  
  120. [-------- DDTerm is invoked -------]
  121.  
  122. (normal terminal operation)
  123.  
  124. [Session Handshake]
  125. HOST:   Send any string containing the characters "[DDTERM "
  126. LOCAL:  Send "DDTERMON"Chr(13) to enable DDTerm packet operation
  127. HOST:   Send packet #255, Host identifier (contains host name)
  128. LOCAL:  Receive host identifier and use it for packet filenames
  129.  
  130. (normal terminal operation)                       <-----<----<----<----<-----
  131.                                                                             :
  132. [Send/Display a packet]                                                    /:\
  133. HOST:   Send "test" command to test for packet                              :
  134. LOCAL:  Check for packet presence (on disk or in RAM). If packet is         :
  135.         present, send <ACK> else send <NAK>                                 :
  136. HOST:   If <ACK> is received, send "Display" command                        :
  137.         If <NAK> is received, send "Receive/Display" command along with     :
  138.         packet data.                                                       /:\
  139.                                                                             :
  140. (normal terminal operation)                                                 :
  141.                                                                             :
  142. [Send color code]                                                           :
  143. HOST:   Send "Set-Foreground" or "Set-Background" command                  /:\
  144. LOCAL:  change color to new foreground/background                           :
  145.                                                                             :
  146. (normal terminal operation)                                                 :
  147.                                                                             :
  148. [-------- Loop until session is over ---------]    >------>------>----->-----
  149.  
  150.  
  151.        As you can see, DDTerm operates as a mix between normal terminal
  152. operation (i.e. sending ASCII characters back and forth) and a packet-protocol
  153. based operation. The packet operation is enabled by the sending of commands
  154. from the HOST (i.e. set-foreground, test, display, receive, etc)
  155.  
  156. Revision History
  157. ----------------
  158.  
  159.       1.00   -First public release
  160.  
  161.       1.10   -Minor bug fixes, too numerous to mention
  162.  
  163.       1.20   -Fixed scrollback to work on monochrome
  164.              -Changed HELP from ALT-H to ALT-Z (to make room for hang up)
  165.              -Added Hang-Up command
  166.              -Improved statistics screen slightly
  167.  
  168.       1.30   -Speeded up "test" command slightly
  169.              -For speed reasons, DDTerm will no longer save packets less
  170.               than 256 bytes to disk.
  171.              -Major face lift - added a pull-down menu system that allows
  172.               you to access most commands.
  173.              -Revised ansi display code - users may now view the scrollback
  174.               buffer/status/etc without causing a packet error with the
  175.               host.
  176.              -Added macro capability. Details are in DDTERM.CTL.
  177.  
  178.       1.40   -added time limit to display
  179.              -added version identification command
  180.  
  181.       2.00   -major version update
  182.              -added dialing directory and autodial command
  183.              -added context sensitive help capabilities
  184.              -added xmodem upload/download commands
  185.              -added xmodem autodownload command
  186.  
  187.       2.10   -fixed problem with things displaying three times
  188.              -added one-line capability (see CTL file) - may increase
  189.               transmission speed dramatically - see CTL file for more
  190.               info.
  191.              -added "reliability" options. Currently, only the above one-line
  192.               command is included
  193.  
  194. COM 3 & 4
  195. ---------
  196.        If you use the fossil based I/O routines (with a fossil driver such as
  197. BNU, X00, or OpusComm, you should have no problem). The internal comm routines
  198. have been tested with COM 1 and 2, but I have had reports that support does
  199. not work correctly with 3 and 4.
  200.  
  201. CREDITS
  202. -------
  203.        The Internal Async I/O routines came from a public domain async library
  204. written by Mark Shultz of Rising Edge Data Services. The internal Xmodem
  205. support came from a public domain package written by Andrew Bartels of Digital
  206. Innovations. I would like to thank these individuals for placing their code in
  207. the public domain for the rest of us to learn and use.
  208.  
  209. DONATIONS:
  210. ----------
  211.        If you find this program useful, please send me a donation at my
  212. address listed below. I can use all the money I can get to keep my BBS up
  213. and running and further my programming projects.
  214.  
  215. Scott Baker
  216. 6431 Tierra Catalina #48
  217. Tucson, AZ 85718
  218.  
  219. BBS NUMBER: (602) 577-3650  2400,1200,300 baud.
  220.  
  221.  
  222.  
  223.  
  224.